/*
 * Copyright (c) 2003-2010, Live Media Pty. Ltd.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice, this list of
 *     conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright notice, this list of
 *     conditions and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *  3. Neither the name of Live Media nor the names of its contributors may be used to endorse
 *     or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.colony.transport.http;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.net.URLConnection;

import com.argot.remote.transport.TypeEndPoint;
import com.argot.remote.transport.TypeEndPointBasic;
import com.colony.mime.MimeInputStream;
import com.colony.mime.MimeOutputSink;

/**
 * This is the HttpEndPoint.  It masks the msg POST requirements
 * of the HTTP protocol.  The endpoint only allows writing in a
 * continuous stream, and then when reading starts the request
 * is made.  No further writing is allowed.
 * 
 * This uses the URLConnection returned from URL.openConnection.
 * This buffers the output until a read is made on the InputStream;
 * at which time it sends the buffered request.  Basically means
 * that large requests are best not made through this method.
 */
public class HttpMimeEndPoint
implements TypeEndPoint
{
	
	private HttpMimeSource _in;
	private MimeOutputSink _out;
	
	private URL _url;
	private URLConnection _urlConnection;
	private boolean _reading;
	
	private InputStream _urlIn;

	public HttpMimeEndPoint( URL url  )
	throws IOException
	{
		_url = url;
		_reading = false;
		_in = new HttpMimeSource();

		// open the connection to server.
		_urlConnection = _url.openConnection();
		_urlConnection.setRequestProperty("Content-Type", "binary/colony");
		_urlConnection.setDoOutput(true);
		_urlConnection.setUseCaches(false);

		_out = new MimeOutputSink( _urlConnection.getOutputStream() );
	}

	public InputStream getInputStream()
	{
		return _in;
	}



	public OutputStream getOutputStream()
	{
		return _out;
	}
	public static TypeEndPoint getEndPoint( URL url )
	throws IOException
	{
		HttpMimeEndPoint endPoint = new HttpMimeEndPoint(url);
		return new TypeEndPointBasic( endPoint._in, endPoint._out );
	}

	/**
	 * The inputStream from the URL can not be openned until the
	 * client has finished sending the POST data.  This class will
	 * open the inputStream when read is first called.  It also
	 * checks the content type to ensure it's colony data.
	 */
	private class HttpMimeSource
	extends MimeInputStream
	{	

		private boolean _inError = false;
		
		private void checkRequest()
		throws IOException
		{
			if ( _reading )
			{
				return;
			}
			else
			{
				if ( _inError )
				{
					throw new IOException("HttpMimeClient in error");
				}
				
				_reading = true;

				// check server resposne.
				String contentType = _urlConnection.getContentType();
				if ( !contentType.equals("binary/argot"))
				{
					_inError = true;
					throw new IOException("bad contentType in server response: '" + contentType + "'");
				}

				// setup the response
				_urlIn = _urlConnection.getInputStream();
			}

		}

		public int read() throws IOException
		{
			checkRequest();
			return _urlIn.read();
		}
		
		public void close() throws IOException
		{
			checkRequest();
			_urlIn.close();			
		}

		public int read(byte[] arg0, int arg1, int arg2) throws IOException
		{
			checkRequest();
			return _urlIn.read( arg0, arg1, arg2 );
		}

		public int read(byte[] arg0) throws IOException
		{
			checkRequest();
			return _urlIn.read(arg0);
		}

	}


	

}
